/* ###
 * IP: GHIDRA
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package ghidra.bitpatterns.gui;

import javax.swing.JPanel;

import docking.DialogComponentProvider;

/**
 * 
 * This is an abstract class for panels used to solicit input from the user
 *
 */
public abstract class InputDialogComponentProvider extends DialogComponentProvider {

	boolean isCanceled;

	protected InputDialogComponentProvider(String title) {
		super(title, true, true, true, false);
	}

	/**
	 * Creates the main input panel
	 * @return the panel
	 */
	abstract protected JPanel createPanel();

	@Override
	protected void okCallback() {
		isCanceled = false;
		close();
	}

	@Override
	protected void cancelCallback() {
		isCanceled = true;
		close();
	}

	/**
	 * Returns true precisely when the dialog was cancelled
	 * @return
	 */
	public boolean isCanceled() {
		return isCanceled;
	}
}
